Skip to content

Error on conversion to unstructured for invalid json.Marshalers. #260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jul 5, 2024
Merged

Error on conversion to unstructured for invalid json.Marshalers. #260

merged 1 commit into from
Jul 5, 2024

Conversation

benluddy
Copy link
Contributor

@benluddy benluddy commented Jun 5, 2024

If a type's implementation of json.Marshaler returns bytes representing a valid JSON object or array followed by anything other than trailing whitespace, return an error rather than ignoring the trailing data. The documentation for the Marshaler interface indicates that implementations shouldn't do this, but it is safer to check (as json.Marshal does) than to rely on it.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 5, 2024
@k8s-ci-robot k8s-ci-robot requested review from apelisse and jpbetz June 5, 2024 17:30
@k8s-ci-robot
Copy link
Contributor

Welcome @benluddy!

It looks like this is your first PR to kubernetes-sigs/structured-merge-diff 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/structured-merge-diff has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 5, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @benluddy. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 5, 2024
jpbetz
jpbetz reviewed Jun 5, 2024
View reviewed changes
@benluddy benluddy force-pushed the json-marshaler-trailing-data branch from 33d3d2b to 361f94a Compare June 5, 2024 19:38
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jun 5, 2024
@jpbetz
Copy link
Contributor

jpbetz commented Jun 5, 2024

/approve

/assign @alexzielenski
Would you be willing to be an extra pair of eyes on this one?

@jpbetz
Copy link
Contributor

jpbetz commented Jun 5, 2024

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 5, 2024
@jpbetz
Copy link
Contributor

jpbetz commented Jun 6, 2024

/approve
(For real now that I've been added to OWNERS)

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: benluddy, jpbetz

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 6, 2024
@benluddy benluddy mentioned this pull request Jul 3, 2024
Merged
sttts
sttts reviewed Jul 5, 2024
View reviewed changes
@benluddy benluddy force-pushed the json-marshaler-trailing-data branch from 361f94a to c0ae2d4 Compare July 5, 2024 14:14
@sttts
Copy link

sttts commented Jul 5, 2024

/lgtm

/hold

in case you want to call convertNumber for the *interface{} case. I think it would be more uniform und expected. Remove hold at will.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 5, 2024
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 5, 2024
@benluddy
Error on conversion to unstructured for invalid json.Marshalers.
f07895d 
If a type's implementation of json.Marshaler returns bytes representing a valid JSON object or array
followed by anything other than trailing whitespace, return an error rather than ignoring the
trailing data. The documentation for the Marshaler interface indicates that implementations
shouldn't do this, but it is safer to check (as json.Marshal does) than to rely on it.
@benluddy benluddy force-pushed the json-marshaler-trailing-data branch from c0ae2d4 to f07895d Compare July 5, 2024 17:23
@benluddy
Copy link
Contributor Author

benluddy commented Jul 5, 2024

in case you want to call convertNumber for the *interface{} case. I think it would be more uniform und expected.

Updated to avoid any surprises in the future.

@sttts
Copy link

sttts commented Jul 5, 2024

/lgtm

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 5, 2024
@sttts
Copy link

sttts commented Jul 5, 2024

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 5, 2024
@k8s-ci-robot k8s-ci-robot merged commit 15fac42 into kubernetes-sigs:master Jul 5, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jpbetz jpbetz jpbetz left review comments

@sttts sttts sttts left review comments

@apelisse apelisse Awaiting requested review from apelisse

Assignees

@alexzielenski alexzielenski

@sttts sttts

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@benluddy @k8s-ci-robot @jpbetz @sttts @alexzielenski